home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / kernel / fsio / fsioDevice.h < prev    next >
C/C++ Source or Header  |  1992-12-18  |  6KB  |  146 lines
  1. /*
  2.  * fsioDevice.h --
  3.  *
  4.  *    Declarations for device access.  The DEVICE operation switch is
  5.  *    defined here.  The I/O handle formas for devices is defined here.
  6.  *
  7.  * Copyright 1987 Regents of the University of California
  8.  * All rights reserved.
  9.  * Permission to use, copy, modify, and distribute this
  10.  * software and its documentation for any purpose and without
  11.  * fee is hereby granted, provided that the above copyright
  12.  * notice appear in all copies.  The University of California
  13.  * makes no representations about the suitability of this
  14.  * software for any purpose.  It is provided "as is" without
  15.  * express or implied warranty.
  16.  *
  17.  *
  18.  * $Header: /cdrom/src/kernel/Cvsroot/kernel/fsio/fsioDevice.h,v 9.6 92/08/10 17:26:48 mgbaker Exp $ SPRITE (Berkeley)
  19.  */
  20.  
  21. #ifndef _FSIODEVICE
  22. #define _FSIODEVICE
  23.  
  24. #include <fsio.h>
  25. #include <fsioLock.h>
  26. #include <fsNameOps.h>
  27.  
  28. /*
  29.  * The I/O descriptor for a local device: FSIO_LCL_DEVICE_STREAM
  30.  */
  31.  
  32. typedef struct Fsio_DeviceIOHandle {
  33.     Fs_HandleHeader    hdr;        /* Standard handle header. The
  34.                      * 'major' field of the fileID is
  35.                      * the device type.  The 'minor'
  36.                      * field is the unit number. */
  37.     List_Links        clientList;    /* List of clients of the device. */
  38.     Fsio_UseCounts        use;        /* Summary reference counts. */
  39.     Fs_Device        device;        /* Device info passed to drivers.
  40.                      * This includes a clientData field. */
  41.     int            flags;        /* Flags returned by the device open.*/
  42.     Fsio_LockState        lock;        /* User level lock state. */
  43.     int            accessTime;    /* Cached version of access time */
  44.     int            modifyTime;    /* Cached version of modify time */
  45.     List_Links        readWaitList;    /* List of waiting reader processes. */
  46.     List_Links        writeWaitList;    /* List of waiting writer processes. */
  47.     List_Links        exceptWaitList;    /* List of process waiting for
  48.                      * exceptions (is this needed?). */
  49.     int            notifyFlags;    /* Bits set to optimize out notifies */
  50. } Fsio_DeviceIOHandle;            /* 136 BYTES */
  51.  
  52. /*
  53.  * Data transferred when a local device stream migrates.
  54.  */
  55. typedef struct Fsio_DeviceMigData {
  56.     int foo;
  57. } Fsio_DeviceMigData;
  58.  
  59. /*
  60.  * The client data set up by the device pre-open routine on the server and
  61.  * used by the device open routine on the client.
  62.  */
  63. typedef struct Fsio_DeviceState {
  64.     int        accessTime;    /* Access time from disk descriptor */
  65.     int        modifyTime;    /* Modify time from disk descriptor */
  66.     Fs_FileID    streamID;    /* Used to set up client list */
  67. } Fsio_DeviceState;
  68.  
  69. /*
  70.  * Paramters for a device reopen RPC used to reestablish state on the
  71.  * I/O server for a device.
  72.  */
  73. typedef struct Fsio_DeviceReopenParams {
  74.     Fs_FileID        fileID;    /* File ID of file to reopen.  MUST BE FIRST! */
  75.     Fsio_UseCounts    use;    /* Device usage information. */
  76. } Fsio_DeviceReopenParams;
  77.  
  78. /*
  79.  * Device support
  80.  */
  81. extern void Fsio_DevNotifyException _ARGS_((Fs_NotifyToken notifyToken));
  82. extern void Fsio_DevNotifyWriter _ARGS_((Fs_NotifyToken notifyToken));
  83. extern void Fsio_DevNotifyReader _ARGS_((Fs_NotifyToken notifyToken));
  84. extern ReturnStatus Fsio_VanillaDevReopen _ARGS_((Fs_Device *devicePtr, 
  85.             int refs, int writes, Fs_NotifyToken notifyToken));
  86.  
  87. /*
  88.  * Open operations.
  89.  */
  90.  
  91. extern ReturnStatus Fsio_DeviceClose _ARGS_((Fs_Stream *streamPtr, 
  92.                 int clientID, Proc_PID procID, int flags, 
  93.                 int size, ClientData data));
  94. /*
  95.  * Recovery testing operations.
  96.  */
  97. extern int Fsio_DeviceRecovTestUseCount _ARGS_((Fsio_DeviceIOHandle *handlePtr));
  98. /*
  99.  * Fast recov stuff.
  100.  */
  101. #include <fsrecovTypes.h>
  102. extern ReturnStatus Fsio_DeviceSetupHandle _ARGS_((Fsrecov_HandleState *recovInfoPtr));
  103.  
  104.  
  105. /*
  106.  * Stream operations.
  107.  */
  108. extern ReturnStatus Fsio_DeviceIoOpen _ARGS_((Fs_FileID *ioFileIDPtr,
  109.         int *flagsPtr, int clientID, ClientData streamData, char *name,
  110.         Fs_HandleHeader **ioHandlePtrPtr));
  111. extern ReturnStatus Fsio_DeviceReopen _ARGS_((Fs_HandleHeader *hdrPtr,
  112.         int clientID, ClientData inData, int *outSizePtr,
  113.         ClientData *outDataPtr));
  114. extern ReturnStatus Fsio_DeviceRead _ARGS_((Fs_Stream *streamPtr, 
  115.         Fs_IOParam *readPtr, Sync_RemoteWaiter *remoteWaitPtr, 
  116.         Fs_IOReply *replyPtr));
  117. extern ReturnStatus Fsio_DeviceWrite _ARGS_((Fs_Stream *streamPtr, 
  118.         Fs_IOParam *writePtr, Sync_RemoteWaiter *remoteWaitPtr, 
  119.         Fs_IOReply *replyPtr));
  120. extern ReturnStatus Fsio_DeviceSelect _ARGS_((Fs_HandleHeader *hdrPtr, 
  121.         Sync_RemoteWaiter *waitPtr, int *readPtr, int *writePtr, 
  122.         int *exceptPtr));
  123. extern ReturnStatus Fsio_DeviceIOControl _ARGS_((Fs_Stream *streamPtr, 
  124.         Fs_IOCParam *ioctlPtr, Fs_IOReply *replyPtr));
  125. extern ReturnStatus Fsio_DeviceGetIOAttr _ARGS_((Fs_FileID *fileIDPtr, 
  126.         int clientID, register Fs_Attributes *attrPtr));
  127. extern ReturnStatus Fsio_DeviceSetIOAttr _ARGS_((Fs_FileID *fileIDPtr, 
  128.         Fs_Attributes *attrPtr, int flags));
  129. extern ReturnStatus Fsio_DeviceMigClose _ARGS_((Fs_HandleHeader *hdrPtr, 
  130.         int flags));
  131. extern ReturnStatus Fsio_DeviceMigrate _ARGS_((Fsio_MigInfo *migInfoPtr, 
  132.         int dstClientID, int *flagsPtr, int *offsetPtr, int *sizePtr,
  133.         Address *dataPtr));
  134. extern ReturnStatus Fsio_DeviceMigOpen _ARGS_((Fsio_MigInfo *migInfoPtr, int size,
  135.         ClientData data, Fs_HandleHeader **hdrPtrPtr));
  136. extern Boolean Fsio_DeviceScavenge _ARGS_((Fs_HandleHeader *hdrPtr));
  137. extern void Fsio_DeviceClientKill _ARGS_((Fs_HandleHeader *hdrPtr, 
  138.         int clientID));
  139. extern Boolean FsioDeviceHandleInit _ARGS_((Fs_FileID *fileIDPtr, 
  140.         char *name, Fsio_DeviceIOHandle **newHandlePtrPtr));
  141. extern ReturnStatus FsioDeviceCloseInt _ARGS_((
  142.         Fsio_DeviceIOHandle *devHandlePtr, int useFlags, int refs,
  143.         int writes));
  144.  
  145. #endif /* _FSIODEVICE */
  146.